GET api/account/{clientID}/orders?status[0]={status[0]}&status[1]={status[1]}

Get a list of orders associated with a client account.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientID	Client account identifier.	integer	Required
status	Order statuses to filter on.	Collection of enOrderStatus	None.

Body Parameters

None.

Response Information

Resource Description

ClientOrders

Name	Description	Type	Additional information
ClientID	Unique client identifier.	integer	None.
ClientName	Client account name.	string	None.
ClientExternalRef	Client external reference.	string	None.
Orders	Order list.	Collection of OrderSimple	None.

Response Formats

application/json, text/json

Sample:

{
  "ClientID": 12345,
  "ClientName": "Sunlign Pty Ltd",
  "ClientExternalRef": "Sunderland",
  "Orders": [
    {
      "OrderID": 12345,
      "SecurityCode": "BHP",
      "BuySell": 1,
      "Quantity": 1240,
      "QuantityBooked": 200,
      "OrderStatus": 1,
      "CreatedTimestamp": "2024-09-29T14:49:38.5779585+10:00",
      "VWAP": 18.2,
      "NettingID": 45678,
      "PriceType": 1,
      "Price": 10.0,
      "DestinationSelected": 1,
      "Creator": "Mr Jeff Joseph",
      "Origin": 12,
      "ClientBrokerageSchedule": "ASXPhoneBrokerLimit",
      "ClientBrokerageScheduleID": 57416,
      "ValidityType": 4,
      "ExpiryDate": "2024-09-29",
      "ExternalOrder": "12345",
      "QuantityFilled": 200,
      "OpenValue": 45.88,
      "MarketRef": "12345",
      "CompletedTimestamp": "2024-09-29T14:49:38.5779585+10:00",
      "NotesForClient": "ABCDEF",
      "OrderGiver": "Testing Order Giver",
      "ClientBrokerageSteps": [
        {
          "BrokerageStepID": 4,
          "MinValue": 13.6364,
          "MinValueGSTInc": 15.0,
          "RateValue": 0.0,
          "RateValueGSTInc": 0.0
        },
        {
          "BrokerageStepID": 5,
          "MinValue": 13.6364,
          "MinValueGSTInc": 15.0,
          "RateValue": 0.000909,
          "RateValueGSTInc": 0.001
        }
      ]
    },
    {
      "OrderID": 15678,
      "SecurityCode": "TLS",
      "BuySell": 2,
      "Quantity": 850,
      "QuantityBooked": 350,
      "OrderStatus": 1,
      "CreatedTimestamp": "2024-09-29T14:49:38.5779585+10:00",
      "VWAP": 27.0,
      "NettingID": 89541,
      "PriceType": 3,
      "Price": 125.2,
      "DestinationSelected": 1,
      "Creator": "Ms Janice",
      "Origin": 14,
      "ClientBrokerageSchedule": "CustomTotalOrAdviceFee $9.0909 or 2.7273%",
      "ClientBrokerageScheduleID": 862605,
      "ValidityType": 6,
      "ExpiryDate": "2024-09-29",
      "ExternalOrder": "15678",
      "QuantityFilled": 200,
      "OpenValue": 45.88,
      "MarketRef": "12345",
      "CompletedTimestamp": "2024-09-29T14:49:38.5779585+10:00",
      "NotesForClient": "ABCDEF",
      "OrderGiver": "Testing Order Giver",
      "ClientBrokerageSteps": [
        {
          "BrokerageStepID": 559332,
          "MinValue": 9.0909,
          "MinValueGSTInc": 10.0,
          "RateValue": 0.027273,
          "RateValueGSTInc": 0.03
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ClientOrders xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.Contracts.Services.Order">
  <ClientExternalRef>Sunderland</ClientExternalRef>
  <ClientID>12345</ClientID>
  <ClientName>Sunlign Pty Ltd</ClientName>
  <Orders>
    <OrderSimple>
      <BuySell>Buy</BuySell>
      <ClientBrokerageSchedule>ASXPhoneBrokerLimit</ClientBrokerageSchedule>
      <ClientBrokerageScheduleID>57416</ClientBrokerageScheduleID>
      <ClientBrokerageSteps>
        <BrokerageStep xmlns="">
          <BrokerageStepID>4</BrokerageStepID>
          <MinValue>13.6364</MinValue>
          <MinValueGSTInc>15.0000</MinValueGSTInc>
          <RateValue>0.00000000</RateValue>
          <RateValueGSTInc>0.000000</RateValueGSTInc>
        </BrokerageStep>
        <BrokerageStep xmlns="">
          <BrokerageStepID>5</BrokerageStepID>
          <MinValue>13.6364</MinValue>
          <MinValueGSTInc>15.0000</MinValueGSTInc>
          <RateValue>0.00090900</RateValue>
          <RateValueGSTInc>0.001000</RateValueGSTInc>
        </BrokerageStep>
      </ClientBrokerageSteps>
      <CompletedTimestamp>2024-09-29T14:49:38.5779585+10:00</CompletedTimestamp>
      <CreatedTimestamp>2024-09-29T14:49:38.5779585+10:00</CreatedTimestamp>
      <Creator>Mr Jeff Joseph</Creator>
      <DestinationSelected>ASX</DestinationSelected>
      <ExpiryDate>2024-09-29T00:00:00+10:00</ExpiryDate>
      <ExternalOrder>12345</ExternalOrder>
      <MarketRef>12345</MarketRef>
      <NettingID>45678</NettingID>
      <NotesForClient>ABCDEF</NotesForClient>
      <OpenValue>45.88</OpenValue>
      <OrderGiver>Testing Order Giver</OrderGiver>
      <OrderID>12345</OrderID>
      <OrderStatus>Active</OrderStatus>
      <Origin>WebServices</Origin>
      <Price>10.00</Price>
      <PriceType>Limit</PriceType>
      <Quantity>1240</Quantity>
      <QuantityBooked>200</QuantityBooked>
      <QuantityFilled>200</QuantityFilled>
      <SecurityCode>BHP</SecurityCode>
      <VWAP>18.2</VWAP>
      <ValidityType>GoodTillExpiry</ValidityType>
    </OrderSimple>
    <OrderSimple>
      <BuySell>Sell</BuySell>
      <ClientBrokerageSchedule>CustomTotalOrAdviceFee $9.0909 or 2.7273%</ClientBrokerageSchedule>
      <ClientBrokerageScheduleID>862605</ClientBrokerageScheduleID>
      <ClientBrokerageSteps>
        <BrokerageStep xmlns="">
          <BrokerageStepID>559332</BrokerageStepID>
          <MinValue>9.0909</MinValue>
          <MinValueGSTInc>10.0000</MinValueGSTInc>
          <RateValue>0.02727300</RateValue>
          <RateValueGSTInc>0.030000</RateValueGSTInc>
        </BrokerageStep>
      </ClientBrokerageSteps>
      <CompletedTimestamp>2024-09-29T14:49:38.5779585+10:00</CompletedTimestamp>
      <CreatedTimestamp>2024-09-29T14:49:38.5779585+10:00</CreatedTimestamp>
      <Creator>Ms Janice</Creator>
      <DestinationSelected>ASX</DestinationSelected>
      <ExpiryDate>2024-09-29T00:00:00+10:00</ExpiryDate>
      <ExternalOrder>15678</ExternalOrder>
      <MarketRef>12345</MarketRef>
      <NettingID>89541</NettingID>
      <NotesForClient>ABCDEF</NotesForClient>
      <OpenValue>45.88</OpenValue>
      <OrderGiver>Testing Order Giver</OrderGiver>
      <OrderID>15678</OrderID>
      <OrderStatus>Active</OrderStatus>
      <Origin>TPPMultiOrderPad</Origin>
      <Price>125.20</Price>
      <PriceType>MarketToLimit</PriceType>
      <Quantity>850</Quantity>
      <QuantityBooked>350</QuantityBooked>
      <QuantityFilled>200</QuantityFilled>
      <SecurityCode>TLS</SecurityCode>
      <VWAP>27</VWAP>
      <ValidityType>GoodTillCancel</ValidityType>
    </OrderSimple>
  </Orders>
</ClientOrders>

Error Response Information

Resource Description

string

Error Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>